Migrating from sphinx to Material for MkDocs #715
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
DeaMariaLeon
commented
Jul 8, 2024
hameerabbasi
requested changes
Jul 19, 2024
There was a problem hiding this comment.
Some minor changes, but LGTM overall. Thanks for all the hard work, @DeaMariaLeon!
DeaMariaLeon
changed the title
|
I think I addressed all the requested changes. Please let me know if something is missing. |
hameerabbasi
requested changes
Jul 22, 2024
hameerabbasi
approved these changes
Jul 22, 2024
There was a problem hiding this comment.
Thanks for this heavy lift and your patience, @DeaMariaLeon! Let's get this in and iterate on it at this point.
|
Thank you @hameerabbasi ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a work in progress in case you want to see locally what I have done.
As you know, if you download my branch, one can see the docs locally running
mkdocs serve.Please note that these points are still pending before starting the next step of adding more documentation.
Cross-reference links.The rest of the mainBut need links fixedrstpages like install, construct, etc, are still missing.Some format on the API documents need to be fixed as well. Like the area of the examples.Headers,logo,footersneed to be added.Website needs to be deployed with mkdocs instead of Sphinx@hameerabbasi @mtsokol